---

Inside Macintosh: QuickTime

Previous | Overview | Contents | Next |

SetTrackUsage

The SetTrackUsage function allows your application to specify whether a track is used in a movie, its preview, its poster, or a combination of these.

pascal void SetTrackUsage (Track theTrack, long usage);


theTrack

Specifies the track for this operation. Your application obtains this track identifier from such Movie Toolbox functions as NewMovieTrack and GetMovieTrack (described on NewMovieTrack and GetMovieTrack , respectively).

usage

Contains flags that specify how the track is to be used. The following flags are defined (be sure to set unused flags to 0):

trackUsageInMovie

The track is used in the movie. If this flag is set to 1, the track is used in the movie.

trackUsageInPreview

The track is used in the preview. If this flag is set to 1, the track is used in the preview.

trackUsageInPoster

The track is used in the poster. If this flag is set to 1, the track is used in the poster.

GetTrackUsage

The GetTrackUsage function allows your application to determine whether a track is used in a movie, its preview, its poster, or a combination of these. Your application can specify how a track is used by calling the SetTrackUsage function, which is described in the previous section.

pascal long GetTrackUsage (Track theTrack);


theTrack

Specifies the track for this operation. Your application obtains this track identifier from such Movie Toolbox functions as NewMovieTrack and GetMovieTrack (described on NewMovieTrack and GetMovieTrack , respectively).

ShowMoviePoster

You can use the ShowMoviePoster function to display a movie's poster. The movie poster uses the movie's matrix and display clipping characteristics.

pascal void ShowMoviePoster (Movie theMovie);


theMovie

Specifies the movie for this operation. Your application obtains this movie identifier from such functions as NewMovie , NewMovieFromFile , and NewMovieFromHandle (described on NewMovie , NewMovieFromFile , and NewMovieFromHandle , respectively).

SetPosterBox

You can use the SetPosterBox function to set a poster's boundary rectangle. You define the poster's image by specifying a time in the movie (use the SetMoviePosterTime function, described on SetMoviePosterTime ). You specify the size and position of the poster image with this function.

pascal void SetPosterBox (Movie theMovie, const Rect *boxRect);


theMovie

Specifies the movie for this operation. Your application obtains this movie identifier from such functions as NewMovie , NewMovieFromFile , and NewMovieFromHandle (described on NewMovie , NewMovieFromFile , and NewMovieFromHandle , respectively).

boxRect

Contains a pointer to a rectangle. The Movie Toolbox sets the poster's boundary rectangle to the coordinates specified in the structure referred to by this parameter.

GetPosterBox

The GetPosterBox function allows you to obtain a poster's boundary rectangle.

pascal void GetPosterBox (Movie theMovie, Rect *boxRect);


theMovie

Specifies the movie for this operation. Your application obtains this movie identifier from such functions as NewMovie , NewMovieFromFile , and NewMovieFromHandle (described on NewMovie , NewMovieFromFile , and NewMovieFromHandle , respectively).

boxRect

Contains a pointer to a rectangle. The Movie Toolbox returns the poster's boundary rectangle into the structure referred to by this parameter.

SetMoviePosterTime

The SetMoviePosterTime function sets the poster time for the movie. Since a movie poster is a still frame, it is defined by a point in time within the movie. The poster's time is expressed in the movie's time coordinate system. Your application can retrieve a poster's time by calling the GetMoviePosterTime function, which is described in the next section.

pascal void SetMoviePosterTime (Movie theMovie,
                                         TimeValue posterTime);


theMovie

Specifies the movie for this operation. Your application obtains this movie identifier from such functions as NewMovie , NewMovieFromFile , and NewMovieFromHandle (described on NewMovie , NewMovieFromFile , and NewMovieFromHandle , respectively).

posterTime

Contains the starting time for the movie frame that contains the poster image.

GetMoviePosterTime

The GetMoviePosterTime function returns the poster's time in the movie. Since a movie poster has no duration, a poster is defined by a point in time within the movie. The time value returned is in the time coordinate system of the movie.

pascal TimeValue GetMoviePosterTime (Movie theMovie);


theMovie

Specifies the movie for this operation. Your application obtains this movie identifier from such functions as NewMovie , NewMovieFromFile , and NewMovieFromHandle (described on NewMovie , NewMovieFromFile , and NewMovieFromHandle , respectively).

PlayMoviePreview

The PlayMoviePreview function plays a movie's preview.

pascal void PlayMoviePreview (Movie theMovie,
                                         MoviePreviewCallOutUPP callOutProc,
                                         long refcon);


theMovie

Specifies the movie for this operation. Your application obtains this movie identifier from such functions as NewMovie , NewMovieFromFile , and NewMovieFromHandle (described on NewMovie , NewMovieFromFile , and NewMovieFromHandle , respectively).

callOutProc

Contains a pointer to a movie callout function in your application. The Movie Toolbox calls this function repeatedly while the movie preview is playing. You can use this function to stop the preview. If you do not want to assign a function, set this parameter to nil .

Your function should have the following form:

                    pascal Boolean MyCallOutProc (long refcon);


The refCon parameter contains the reference constant you specified when you called the PlayMoviePreview function.

Your function returns a Boolean value. The Movie Toolbox examines this value before continuing. If your function sets this value to false , the Movie Toolbox stops the preview and returns to your application. For details, see "Movie Callout Functions" .

Note that if you call the GetMovieActiveSegment function (described on GetMovieActiveSegment ) from within your movie callout function, the Movie Toolbox will have changed the active movie segment to be the preview segment of the movie. The Movie Toolbox restores the active segment when the preview is done playing.

refcon

Contains a reference constant for your function. The Movie Toolbox passes this value to your function.

SetMoviePreviewMode

The SetMoviePreviewMode function allows your application to place a movie into and out of preview mode. When a movie is in preview mode, only those tracks identified as preview tracks are serviced. You specify how a track is used by calling the SetTrackUsage function, which is described on SetTrackUsage .

pascal void SetMoviePreviewMode (Movie theMovie,
                                         Boolean usePreview);


theMovie

Specifies the movie for this operation. Your application obtains this movie identifier from such functions as NewMovie , NewMovieFromFile , and NewMovieFromHandle (described on NewMovie , NewMovieFromFile , and NewMovieFromHandle , respectively).

usePreview

Specifies the movie's mode. Set this parameter to true to place the movie into preview mode. Set this parameter to false to place the movie into normal playback mode.

GetMoviePreviewMode

The GetMoviePreviewMode function allows your application to determine whether a movie is in preview mode. If a movie is in preview mode, only the movie's preview can be displayed. Your application can place a movie into and out of preview mode by calling the SetMoviePreviewMode function, which is described in the previous section.

pascal Boolean GetMoviePreviewMode (Movie theMovie);


theMovie

Specifies the movie for this operation. Your application obtains this movie identifier from such functions as NewMovie , NewMovieFromFile , and NewMovieFromHandle (described on NewMovie , NewMovieFromFile , and NewMovieFromHandle , respectively).

SetMoviePreviewTime

The SetMoviePreviewTime function allows your application to define the starting time and duration of the movie's preview. These time values are in the movie's time coordinate system.

pascal void SetMoviePreviewTime (Movie theMovie,
                                         TimeValue previewTime,
                                         TimeValue previewDuration);


theMovie

Specifies the movie for this operation. Your application obtains this movie identifier from such functions as NewMovie , NewMovieFromFile , and NewMovieFromHandle (described on NewMovie , NewMovieFromFile , and NewMovieFromHandle , respectively).

previewTime

Contains a time value that specifies the preview's starting time.

previewDuration

Contains a time value that specifies the preview's duration.

GetMoviePreviewTime

The GetMoviePreviewTime function returns the starting time and duration of the movie's preview. These time values are expressed in the movie's time coordinate system.

pascal void GetMoviePreviewTime (Movie theMovie,
                                         TimeValue *previewTime,
                                         TimeValue *previewDuration);


theMovie

Specifies the movie for this operation. Your application obtains this movie identifier from such functions as NewMovie , NewMovieFromFile , and NewMovieFromHandle (described on NewMovie , NewMovieFromFile , and NewMovieFromHandle , respectively).

previewTime

Contains a pointer to a time value. The Movie Toolbox places the preview's starting time into the field referred to by this parameter. If the movie does not have a preview, the Movie Toolbox sets this returned value to 0.

previewDuration

Contains a pointer to a time value. The Movie Toolbox places the preview's duration into the field referred to by this parameter. If the movie does not have a preview, the Movie Toolbox sets this returned value to 0.